/*
 * Copyright (c) 2013, SRI International
 * All rights reserved.
 * Licensed under the The BSD 3-Clause License;
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 * 
 * http://opensource.org/licenses/BSD-3-Clause
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * 
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 * 
 * Neither the name of the aic-web-praise nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.sri.ai.lpitools.cobra.server.data.implementations.db;

import java.io.PrintStream;
import java.sql.ResultSet;
import java.sql.ResultSetMetaData;
import java.sql.SQLException;


import org.apache.commons.logging.Log;
import org.apache.log4j.Logger;

/**
 * Debugging utilities to display information from a ResultSet
 */
public class DatabaseUtils {
	private static Logger logger = Logger.getLogger(DatabaseUtils.class);
	
    /**
     * Pretty-prints current row of a JDBC result set to standard out
     * Does not change position of ResultSet pointer
     *
     * @param results ResultSet to be printed
     */
    public static void printResultSetRow(ResultSet results, PrintStream printStream) {

        try {
            ResultSetMetaData md = results.getMetaData();
            printStream.println(md.getTableName(1));
            for (int i = 1; i <= md.getColumnCount(); i++) {
            	printStream.println("  " + md.getColumnLabel(i) + "\t= " + results.getString(i));
            }
        } catch (SQLException e) {
            logger.error(e);
        }

    }

    /**
     * Pretty-prints current row of a JDBC result set to the log
     * Does not change position of ResultSet pointer
     *
     * @param results ResultSet to be printed
     */
    public static void logResultSetRow(Log log, ResultSet results) {
        try {
            ResultSetMetaData md = results.getMetaData();
            log.info(md.getTableName(1));
            for (int i = 1; i <= md.getColumnCount(); i++) {
                log.info("  " + md.getColumnLabel(i) + "\t= " + results.getString(i));
            }
        } catch (SQLException e) {
            logger.error(e);
        }
    }
}
